πŸ’¬ 쒋은 μ½”λ“œ

@Seongukbaek Posted January 05, 2022 Β· Updated January 05, 2022 Β· 12 min read

⌘ 쒋은 μ½”λ“œ ?

쒋은 μ½”λ“œλΌκ³  ν•˜λ©΄ κ³Όμ—° μ–΄λ–€ 게 쒋은 κ²ƒμΌκΉŒ ?

  • 읽기 μ‰¬μš΄ μ½”λ“œ ?
  • 쀑볡이 μ—†λŠ” μ½”λ“œ ?
  • ν…ŒμŠ€νŠΈκ°€ μš©μ΄ν•œ μ½”λ“œ ?

읽기 μ‰¬μš΄ μ½”λ“œ

읽기 μ‰¬μš°λ €λ©΄, μž‘μ„±μžμ—κ²Œ μ΅μˆ™ν•œ μ–Έμ–΄λ₯Ό μ‚¬μš©ν•˜λ©΄ λœλ‹€. 그리고 ν•œκ΅­μ–΄λ‘œ 적힌 주석도 μ μ ˆν•˜κ²Œ 달아주면 잘 μ½νžˆμ§€ μ•Šμ„κΉŒ.

ν•˜μ§€λ§Œ

주석은 관리가 μ–΄λ ΅λ‹€λŠ” 단점이 μžˆλ‹€.
  • 주석은 메타데이터이기에 λ‚΄μš©κ³Ό ν•¨μˆ˜μ˜ μ‹€μ œ λ™μž‘μ— λŒ€ν•œ 보μž₯이 μ–΄λ ΅λ‹€.
  • μˆ˜μ‹œλ‘œ λ°œμƒν•˜λŠ” μˆ˜μ •μ‚¬ν•­μ— λŒ€ν•΄ 주석이 λ™κΈ°ν™”λ˜μ§€ μ•ŠμœΌλ©΄, 였히렀 더 큰 ν˜Όλž€μ„ μ•ΌκΈ°ν•  수 μžˆλ‹€.
'읽기 쉽닀' λΌλŠ” 말 자체의 λͺ¨ν˜Έμ„± ?

읽기 μ‰½λ‹€λŠ” κ²ƒμ˜ 기쀀은 μ‚¬λžŒλ§ˆλ‹€ λ„ˆλ¬΄ λ‹€λ₯Ό 것이닀. λ³€μˆ˜λͺ… λ˜λŠ” ν•¨μˆ˜λͺ…에 λŒ€ν•œ 넀이밍은 μ‚¬λžŒλ§ˆλ‹€ 맀우 λ‹€λ₯΄κΈ°μ—, 각자의 배경지식 μˆ˜μ€€μ— 따라 기쀀이 λͺ¨ν˜Έν•˜λ‹€.

λ˜ν•œ, μ½”λ“œλ₯Ό μž‘μ„±ν•˜λŠ” μ‹œμ μ—λŠ” 이해도가 100%μ΄μ§€λ§Œ, μ΄λŠ” 점점 λ–¨μ–΄μ§€κΈ° λ•Œλ¬Έμ— 아무리 μ½”λ“œ μž‘μ„±μ— λ…Έλ ₯을 가해도 ν•œκ³„λŠ” μ‘΄μž¬ν•  μˆ˜λ°–μ— μ—†λ‹€.

쀑볡이 μ—†λŠ” μ½”λ“œ

λ™μΌν•œ λ‘œμ§μ„ μˆ˜ν–‰ν•˜λŠ” μ½”λ“œκ°€ 쀄쀄 μž‘μ„±λ˜μ–΄ μžˆλ‹€λ©΄, λŒ€λΆ€λΆ„μ€ 이λ₯Ό μΆ”μΆœν•˜μ—¬ ν•¨μˆ˜ν™”ν•˜κΈ°λ₯Ό 원할 것이닀. (λ˜λŠ” 반볡문?) μ™œλƒν•˜λ©΄, μ΄λŸ¬ν•œ 동일 μ½”λ“œκ°€ μ—¬λŸ¬ ꡰ데 λ„λΈŒλŸ¬μ Έ μžˆλŠ” 것은 "λΆˆνŽΈν•˜λ‹€"κ³  λŠκ»΄μ§€κΈ° λ•Œλ¬Έμ΄λ‹€.

μ΄λ ‡κ²Œ μΆ”μΆœν•œ μ½”λ“œλŠ” μ‹œκ°„μ΄ μ§€λ‚˜ 쑰금 λ‹€λ₯Έ 역할을 μˆ˜ν–‰ν•˜κΈ° μœ„ν•΄ μˆ˜μ •λ˜μ–΄μ Έμ•Ό ν•  수 μžˆλ‹€. μ΄λ•Œ, μΆ”μΆœλ˜μ—ˆλ˜ μ½”λ“œλ₯Ό λ‹€μ‹œ ν•©μΉ˜κ±°λ‚˜ μˆ˜μ •ν•΄μ•Ό ν•˜λŠ”λ° λΉ„μš©μ΄ λ°œμƒν•˜κ²Œ λœλ‹€.

ν…ŒμŠ€νŠΈκ°€ μš©μ΄ν•œ μ½”λ“œ

ν…ŒμŠ€νŠΈλŠ” 맀우 μ€‘μš”ν•œ 역할을 ν•œλ‹€. μž‘μ„±ν•œ μ½”λ“œμ— λŒ€ν•œ ν™•μ‹€ν•œ 증거가 될 수 μžˆλ‹€.

ν•˜μ§€λ§Œ ν…ŒμŠ€νŠΈκ°€ μš©μ΄ν•΄μ•Ό 쒋은 μ½”λ“œμΌκΉŒ? μ–΄λ–»κ²Œ ν•˜λ©΄ ν…ŒμŠ€νŠΈκ°€ μš©μ΄ν•œ μ½”λ“œλ₯Ό μž‘μ„±ν•  수 μžˆμ„κΉŒ?


⌘ μ’‹μ§€ μ•Šμ€ μ½”λ“œκ°€ μƒμ‚°λ˜λŠ” 이유 ?

λͺ¨λ‘λ“€ 쒋은 μ½”λ“œλ₯Ό μƒμ„±ν•˜κ³  μ‹Άμ§€λ§Œ, μ’‹μ§€ μ•Šμ€ μ½”λ“œλ₯Ό μƒμ‚°ν•˜λŠ” κ²°κ³Όλ₯Ό λ§žμ΄ν•˜κΈ°λ„ ν•œλ‹€. 그럼 μ–΄μ©Œλ‹€κ°€ μ½”λ“œκ°€ μ’‹μ§€ λͺ»ν•œ λ°©ν–₯으둜 μƒμ‚°λ˜κ²Œ 될까?

μš°λ¦¬κ°€ λ§ˆμ£Όν•˜λŠ” 상황

μƒˆλ‘œμš΄ ν”„λ‘œμ νŠΈμ— λŒ€ν•œ κ°œλ°œμ„ μ§„ν–‰ν•˜κΈ°λ„ ν•˜κ³ , 이미 μ‘΄μž¬ν•˜λŠ” ν”„λ‘œμ νŠΈμ— λŒ€ν•œ λ¦¬νŒ©ν† λ§μ„ μ§„ν–‰ν•˜κΈ°λ„ ν•œλ‹€.

쓰이지 μ•ŠλŠ” μ½”λ“œ

μ—¬λŸ¬ 번의 μˆ˜μ •μ„ 거쳐, κ²°κ΅­μ—” 쓰이지 μ•Šκ²Œ 된 μ½”λ“œκ°€ μžˆμ„ 것이닀. μ΄λŸ¬ν•œ μ½”λ“œμ˜ ν˜ΈμΆœλ²”μœ„μ— λŒ€ν•œ 확신이 μ—†λ‹€λ©΄, λ‹€λ₯Έ μ½”λ“œλ“€μ— λŒ€ν•œ μœ„ν—˜μš”μ†Œκ°€ 될 수 μžˆλ‹€.

"κΉ¨μ§„ 유리창" μ΄λΌλŠ” ν‘œν˜„μ΄ μ•„μ£Ό 쒋은 것 κ°™λ‹€. μ°Έκ³ μ—μ„œ κ°€μ Έμ˜¨ ν‘œν˜„

거리

μ½”λ“œκ°€ λ™μž‘ν•˜λŠ” κ³³κ³Ό μ½”λ“œκ°€ μ„ μ–Έλœ 곳의 물리적인 거리가 λ©€λ©΄, νŒŒμ•…μ΄ μ–΄λ €μ›Œμ§„λ‹€. μ„ μ–Έν•œ μ½”λ“œμ˜ λ™μž‘λ²”μœ„λ₯Ό μ •ν™•ν•˜κ²Œ μ œμ–΄ν•  수 μžˆλ‹€λ©΄, μ΄λŸ¬ν•œ λΆˆμ•ˆκ°μ€ ν•΄μ†Œλ  수 μžˆλ‹€.

μˆœμˆ˜ν•˜μ§€ μ•Šμ€ ν•¨μˆ˜

ν•¨μˆ˜μ˜ μ™ΈλΆ€μ˜ νŠΉμ • 값을 기반으둜 λ™μž‘ν•˜λŠ” ν•¨μˆ˜λŠ”, (μ™ΈλΆ€μ˜ νŠΉμ • 값에 μ˜μ‘΄ν•˜λŠ” ν•¨μˆ˜) κ·Έ side effect λ₯Ό μ œμ–΄ν•˜λŠ” 것이 μ–΄λ ΅λ‹€.

ν•¨μˆ˜μ˜ μž…μΆœλ ₯만으둜 ν•¨μˆ˜ λ‚΄λΆ€λ₯Ό μˆ˜μ •ν•  수 μ—†λ‹€λ©΄, μˆœμˆ˜ν•˜μ§€ μ•Šμ€ ν•¨μˆ˜λΌκ³  ν•œλ‹€.

κΈ‰ν•˜κ²Œ μˆ˜μ •ν•œ μ½”λ“œ

좔가적인 λ‘œμ§μ„ μˆ˜ν–‰ν•˜κΈ° μœ„ν•΄, μ‚¬μš©ν•˜λŠ” κ³³μ—μ„œ μˆ˜μ •μ΄ 이뀄져야 ν•˜λŠ” 경우λ₯Ό μ’…μ’… λ³Ό 수 μžˆλ‹€. 이런 경우, side effectκ°€ λ°œμƒν•˜λŠ” 것을 ν”Όν•˜κ³ μž, ν•¨μˆ˜μ— μž…λ ₯을 μΆ”κ°€ν•˜κ±°λ‚˜, μ˜΅μ…˜μ„ λ³€κ²½μ‹œμΌœ λ‹Ήμž₯은 μ •μƒμ μœΌλ‘œ λ™μž‘ν•˜λŠ” κ²ƒμ²˜λŸΌ 보이게 ν•΄κ²°ν•  μˆ˜λŠ” μžˆλ‹€.

ν•˜μ§€λ§Œ μ΄λŸ¬ν•œ μ‘κΈ‰μ²˜μΉ˜λ₯Ό μ—¬λŸ¬ 번 거친 ν•¨μˆ˜λŠ”, μ‰½κ²Œ μ•Œμ•„λ³Ό 수 μ—†λŠ” μ½”λ“œλ‘œ λ³€ν•˜κ²Œ λœλ‹€.

μ—¬κΈ°μ„œ, κΈ°μˆ λΆ€μ±„ λΌλŠ” ν‘œν˜„μ΄ λ“±μž₯ν•œλ‹€. μ°Έκ³ μ—μ„œ κ°€μ Έμ˜¨ ν‘œν˜„


⌘ μ’‹μ§€ μ•Šμ€ μ½”λ“œ 쀄이기

"쒋은 μ½”λ“œ" λ₯Ό μ •μ˜ν•˜λŠ” 것은 μ–΄λ ΅λ‹€. κ·Έλ ‡λ‹€λ©΄ λ°˜λŒ€λ‘œ, μœ„μ—μ„œ 닀룬 μ’‹μ§€ μ•Šμ€ μ½”λ“œλ₯Ό μ€„μ΄λŠ” 방법을 νƒν•œλ‹€.

μΆ”μΆœ, 좔상화

어원을 μ‚΄νŽ΄λ³΄λ©΄, λ‘˜ λ‹€ -tract(λŒμ–΄λ‚΄κΈ°)κ³Ό κ²°ν•©λœ 합성어이닀. κ·Έλ ‡λ‹€λ©΄ ex-, ab- κ³Ό κ²°ν•©λ˜μ–΄ μ–΄λ–»κ²Œ λ‹€λ₯ΌκΉŒ?

μΆ”μΆœ

ex- λŠ” 'λ°–μœΌλ‘œ' λΌλŠ” 의미λ₯Ό κ°€μ§„λ‹€. μ€‘μš”ν•œ λΆ€λΆ„κ³Ό κ΄€λ ¨λœ κ°œλ…λ“€μ„ λŒμ–΄λ‚΄λŠ” 것이닀.

좔상화

ab- λŠ” 'ν˜•μƒμ μΈ λͺ¨μŠ΅κ³ΌλŠ” λ¨Ό κ°œλ…' μ΄λΌλŠ” 의미λ₯Ό κ°€μ§„λ‹€. 즉, 싀체가 μ—†λŠ” 좔상적인 κ°œλ…λ“€μ„ λŒμ–΄λ‚΄ μžμ‹ λ§Œμ˜ λ°©μ‹μœΌλ‘œ μ •λ¦¬ν•œ 것이닀.

μ˜μ‘΄μ„±μ„ λ“œλŸ¬λ‚΄κΈ° μœ„ν•œ 좔상화

μš°λ¦¬κ°€ μ½”λ“œλ₯Ό μΆ”μΆœν•˜λŠ” μ΄μœ λŠ” μž¬μ‚¬μš©μ˜ μš©μ΄μ„±, λ„ˆλ¬΄ μ»€μ§€λŠ” 파일이라고 ν•  수 μžˆλ‹€. λ‹¨μˆœνžˆ μ€‘λ³΅λœ μ½”λ“œ 덩어리(chunk)에 λŒ€ν•΄ μΆ”μΆœν•˜λ©΄ μž¬μ‚¬μš©μ΄ μ–΄λ €μ›Œμ§„λ‹€. 였히렀 ν•¨μˆ˜ κ°„μ˜ 의쑴 관계λ₯Ό νŒŒμ•…ν•˜κΈ° μœ„ν•΄ μΆ”κ°€ λΉ„μš©μ΄ λ°œμƒν•˜λ―€λ‘œ, μ΄λŠ” 잘λͺ» μΆ”μΆœν•œ 것이닀.

ν•¨μˆ˜λ₯Ό 뢄리할 λ•ŒλŠ” ν•¨μˆ˜μ˜ 역할을 μΈμ§€ν•˜κ³  ν•˜λ‚˜μ˜ μ—­ν• λ§Œ ν•˜λ„λ‘ μ •μ˜ν•΄μ•Ό ν•œλ‹€. 즉 μ˜μ‘΄μ„±μ„ λ“œλŸ¬λ‚΄κΈ° μœ„ν•¨μ΄ μΆ”μΆœμ˜ λͺ©μ μ΄ λ˜μ–΄μ•Ό ν•œλ‹€.

ν•œ νŒŒμΌμ— μ—¬λŸ¬ 둜직이 μ–½ν˜€μžˆμ„ λ•Œ 각 μ½”λ“œ 쑰각 쀑 μ„œλ‘œ 의쑴 관계에 μžˆλŠ” 것듀을 μΆ”μΆœν•˜μ—¬ 좔상화가 된 ν•¨μˆ˜κ°€ ν•˜λ‚˜μ˜ λͺ©μ (μ—­ν• )λ§Œμ„ 갖도둝 ν•΄μ•Ό ν•œλ‹€.

μ‚­μ œν•˜κΈ° μ‰¬μš΄ μ½”λ“œμ™€ μ–΄λ €μš΄ μ½”λ“œμ˜ 뢄리

λΉ„μ¦ˆλ‹ˆμŠ€ μš”κ΅¬μ‚¬ν•­μ„ λ§žμΆ”λ‹€λ³΄λ©΄ μ–΄μ©” 수 없이 λ³΅μž‘ν•œ μ½”λ“œκ°€ 생산될 수 밖에 μ—†λ‹€. μ‚¬μš©ν•˜λŠ” 라이브러리의 문제일 μˆ˜λ„ 있고, μ—¬λŸ¬ λΈŒλΌμš°μ €μ— λŒ€μ‘ν•˜κΈ° μœ„ν•΄ μƒμ‚°λœ μ½”λ“œμΌ μˆ˜λ„ μžˆλ‹€.

μ΄λŸ¬ν•œ μ½”λ“œλ“€μ€ 제 3자의 μž…μž₯μ—μ„œλŠ” μ„£λΆˆλ¦¬ μ–΄μ°Œν•  수 없기에, λ³„λ„λ‘œ 뢄리해야 ν•œλ‹€. μ–΄λ ΅λ‹€λ©΄, μ œλŒ€λ‘œ 관리, ν†΅μ œν•  수 μžˆλ„λ‘ κ²©λ¦¬ν•˜μ—¬μ•Ό ν•œλ‹€. 이 λ•Œ, 주석과 ν•¨κ»˜ κ²©λ¦¬ν•˜μ—¬ κ΄€λ¦¬ν•˜λ„λ‘ ν•œλ‹€.

일관성 μžˆλŠ” μ½”λ“œ

μ΅œμ†Œν•œμ˜ μ½”λ“œ 가독성을 보μž₯ν•˜κΈ° μœ„ν•΄μ„œλŠ” κ°œλ°œν•˜λŠ” μ½”λ“œμ˜ 일관성을 μœ μ§€ν•˜λŠ” 것이닀. ν•©μ˜λœ κ·œμΉ™μ„ μ‚¬μš©ν•˜μ—¬ κ°œκ°œμΈμ—κ²Œ λ™μΌν•˜κ²Œ μ μš©λ˜λ„λ‘ ν•œλ‹€.

일관성이 μ§€μΌœμ§„λ‹€λ©΄, μ½”λ“œμ— λŒ€ν•œ μ˜ˆμƒλ„ κ°€λŠ₯ν•˜λ‹€. νŠΉμ • μ½”λ“œκ°€ 어디에 μœ„μΉ˜λ  μ§€ 예츑이 κ°€λŠ₯ν•˜λ‹€λŠ” μ˜λ―Έμ΄λ‹€.

NAMING

λ³€μˆ˜μ˜ Naming 뿐 μ•„λ‹ˆλΌ ν•¨μˆ˜μ˜ Naming에도 ν•©μ˜λœ κ·œμΉ™μ΄ μ‘΄μž¬ν•˜λ©΄ 일관성을 μœ μ§€ν•  수 μžˆλ‹€.

// Case 1. // prefix: handle // target: button // action: click const handleButtonClick = () => {} // Case 2. // prefix: on // action: click // target: button const onClickButton = () => {}

μœ„ μ˜ˆμ‹œμ²˜λŸΌ, prefix , target , action 이 μΌκ΄€λœ κ·œμΉ™μœΌλ‘œ Naming을 μˆ˜ν–‰ν•˜μ—¬ ν•¨μˆ˜μ˜ νŒŒμ•…μ„ λ„μšΈ 수 μžˆλ‹€.

DIRECTORY

λ””λ ‰ν„°λ¦¬λŠ” μ½”λ“œλ₯Ό μ–΄λ””λ‘œ 뢄리할지와 관련이 μžˆλ‹€. μΌκ΄€λœ 디렉터리 κ΅¬μ‘°λŠ” 전체 ꡬ쑰λ₯Ό νŒŒμ•…ν•˜κ³  μ½”λ“œμ˜ 역할을 μ΄ν•΄ν•˜λŠ”λ° 큰 도움이 λœλ‹€.

디렉터리 κ΅¬μ‘°λŠ” 크게 역할에 따라, νŽ˜μ΄μ§€(도메인)에 따라 뢄리할 수 μžˆλ‹€. μ• ν”Œλ¦¬μΌ€μ΄μ…˜μ΄ 컀지고 λ³΅μž‘ν•΄μ§€λ©΄,

  • μ „μžμ˜ 경우, μ½”λ“œκ°€ μ •μ˜λœ κ³³κ³Ό μ‚¬μš©λ˜λŠ” 곳이 λ©€μ–΄μ§€λŠ” 문제점이 λ°œμƒν•œλ‹€. μ΄λŠ” μœ„μ—μ„œ 닀룬 거리에 λŒ€ν•œ 문제둜 μ½”λ“œ μ œμ–΄λ₯Ό μ–΄λ ΅κ²Œ λ§Œλ“€ 수 μžˆλ‹€.
  • ν›„μžλŠ” Featured Based라고 ν•  수 μžˆλŠ”λ° μ΄λŸ¬ν•œ ꡬ쑰둜 거리 문제λ₯Ό ν•΄κ²°ν•  수 μžˆλ‹€. μ• ν”Œλ¦¬μΌ€μ΄μ…˜ μ „λ°˜μ—μ„œ κ³΅ν†΅μœΌλ‘œ μ‚¬μš©λ˜λŠ” κ²ƒλ“€λ§Œ Top Level의 @shared λ””λ ‰ν„°λ¦¬μ—μ„œ κ΄€λ¦¬ν•˜κ³  λ‚˜λ¨Έμ§€λŠ” 응집도 λ†’κ²Œ 각각의 λ””λ ‰ν„°λ¦¬μ—μ„œ κ΄€λ¦¬ν•œλ‹€.

ν™•μž₯μ„± μžˆλŠ” μ½”λ“œ

ν™•μž₯성이 μ—†λŠ” μ½”λ“œμ˜ 경우, μˆ˜μ •μ‚¬ν•­μ— λŒ€ν•œ λ§Žμ€ 변경을 μš”κ΅¬ν•˜λ©°, μžμ—°νžˆ 생산성이 λ–¨μ–΄μ§€λŠ” μš”μ†Œκ°€ λœλ‹€. ν™•μž₯μ„±μ˜ 보μž₯을 μœ„ν•΄, 기쑴의 HTML HTML elementκ°€ 받을 수 μžˆλŠ” attributeλ₯Ό λͺ¨λ‘ μˆ˜μš©ν•  수 μžˆλ„λ‘ κ΅¬ν˜„ν•΄μ•Ό ν•œλ‹€.


πŸ’‘ 정리

쒋은 μ½”λ“œλΌλŠ” μ •μ˜μ˜ 닡은 μ—†λŠ” 것 κ°™λ‹€. μ•„λ§ˆ κ°œλ°œμžλΌλŠ” 직업을 κ°€μ§€κ³  μ‚¬λŠ” 이상 ν‰μƒμ˜ μˆ™μ œκ°€ μ•„λ‹κΉŒ μ‹Άλ‹€. κ·Έλž˜μ„œ μ’‹μ§€ μ•Šμ€ μ½”λ“œλ₯Ό μ΅œλŒ€ν•œ λ§Œλ“€μ§€ μ•Šλ„λ‘ ν•˜λŠ” 것이 κ³§ 쒋은 μ½”λ“œλ₯Ό λ§Œλ“€μ–΄λ‚΄λŠ” 방법이 μ•„λ‹κΉŒ μƒκ°ν•œλ‹€.

🚩 참고

쒋은 μ½”λ“œ λ₯Ό 많이 μ°Έκ³ ν•˜μ—¬ 제 생각을 λ§λΆ™μ—¬λ΄€μŠ΅λ‹ˆλ‹€.

@Seongukbaek
배우고 μ •λ¦¬ν•˜κ³  κ³΅μœ ν•˜λŠ” λŒ€ν•™μƒ λ°±μ„±μš±μž…λ‹ˆλ‹€ πŸ˜€